You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Code cleanliness and completeness is addressed via guidelines
README Checks
[] README has proper context for the reviewer to understand what the code includes, any important design considerations, and areas to pay more attention to
Code Checks
Add explanatory comments. If there is complex code that requires specific context or understanding, note that in a comment
Remove unncessary comments. Any comments that do not add additional context, information, etc. should be removed
Add javadocs.
[] Scrub through the code for inconsistencies (e.g. removing extra spaces)
[] Ensure there are not any .onlys in spec files
Broader Considerations
Ensure variable, function and event naming is clear, consistent, and reflective for the scope of the code.
Consider if certain pieces of logic should be placed in a different library, module
Change trading parameters (token amounts) in relative terms (to the total set supply) rather than in absolute/notional amounts.
Add methods to allow fixed-output-redemptions and fixed-input-mints (basically not fixing the fCash amount but the underlying / asset token instead) and rename existing methods to differentiate them.
Address issues raised in codearena audit:
Add (configurable) gas limit in external function call to getDecodedID inside isWrappedFCash to avoid wasting excessive amounts of gas. (For example fallback method of cEth token wasted all of the gas leading to revertions)
Reset allowances to zero after minting / redeeming to avoid leftover allowances. (and potential revertions on tokens which don't allow changing non-zero allowances such as USDT)
Allow manager to disable automatic redemption of matured positions upon issuance / redemption to avoid persistent revertions in external calls from freezing user funds.
Add _safeUint88 function to avoid silent overflows when downcasting uint256 fCash amounts to uint88 datatype expected by wrappedfCash
Various smaller changes based on QA / gas optimization feedback from the audit contest. (typos, natspec comments etc)
Repo Cleanup:
Remove manual deployment of wFCashFactory etc. in integration tests and related imports etc.. Instead use factory instance deployed by the notional team.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Code Review Processes
New Feature Review
Before submitting a pull request for new review, make sure the following is done:
README Checks
Code Checks
Broader Considerations